/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.availability;

import org.springframework.context.ApplicationContext;

/**
 * 提供应用程序的 {@link AvailabilityState 可用性状态} 信息。
 * <p>
 * 组件可以注入此类以获取当前的状态信息。若要更新应用程序的状态，应通过
 * {@link ApplicationContext#publishEvent} 向应用上下文发布一个
 * {@link AvailabilityChangeEvent}，可以直接发布也可以通过
 * {@link AvailabilityChangeEvent#publish} 发布。
 *
 * @author Brian Clozel
 * @author Phillip Webb
 * @since 2.3.0
 */
public interface ApplicationAvailability {

	/**
	 * 返回应用程序的 {@link LivenessState}（存活状态）。
	 * @return 存活状态
	 */
	default LivenessState getLivenessState() {
		return getState(LivenessState.class, LivenessState.BROKEN);
	}

	/**
	 * 返回应用程序的 {@link ReadinessState}（就绪状态）。
	 * @return 就绪状态
	 */
	default ReadinessState getReadinessState() {
		return getState(ReadinessState.class, ReadinessState.REFUSING_TRAFFIC);
	}

	/**
	 * 返回应用程序的 {@link AvailabilityState} 信息。
	 * @param <S> 状态类型
	 * @param stateType 状态的类型
	 * @param defaultState 如果尚未发布指定类型的事件，则返回的默认状态（不能为 {@code null}）
	 * @return 准备状态
	 * @see #getState(Class)
	 */
	<S extends AvailabilityState> S getState(Class<S> stateType, S defaultState);

	/**
	 * 返回应用程序的 {@link AvailabilityState} 信息。
	 * @param <S> 状态类型
	 * @param stateType 状态的类型
	 * @return 准备状态，若尚未发布指定类型的事件则返回 {@code null}
	 * @see #getState(Class, AvailabilityState)
	 */
	<S extends AvailabilityState> S getState(Class<S> stateType);

	/**
	 * 返回指定状态类型最近收到的 {@link AvailabilityChangeEvent}。
	 * @param <S> 状态类型
	 * @param stateType 状态的类型
	 * @return 准备状态，若尚未发布指定类型的事件则返回 {@code null}
	 */
	<S extends AvailabilityState> AvailabilityChangeEvent<S> getLastChangeEvent(Class<S> stateType);

}
